// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "base/i18n/icu_util.h"

#if defined(OS_WIN)
#include <windows.h>
#endif

#include <string>

#include "base/debug/alias.h"
#include "base/files/file_path.h"
#include "base/files/memory_mapped_file.h"
#include "base/logging.h"
#include "base/path_service.h"
#include "base/strings/string_util.h"
#include "base/strings/sys_string_conversions.h"
#include "build/build_config.h"
#include "third_party/icu/source/common/unicode/putil.h"
#include "third_party/icu/source/common/unicode/udata.h"
#if defined(OS_LINUX) && !defined(OS_CHROMEOS)
#include "third_party/icu/source/i18n/unicode/timezone.h"
#endif

#if defined(OS_ANDROID)
#include "base/android/apk_assets.h"
#endif

#if defined(OS_IOS)
#include "base/ios/ios_util.h"
#endif

#if defined(OS_MACOSX)
#include "base/mac/foundation_util.h"
#endif

namespace base {
namespace i18n {

#if ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_SHARED
#define ICU_UTIL_DATA_SYMBOL "icudt" U_ICU_VERSION_SHORT "_dat"
#if defined(OS_WIN)
#define ICU_UTIL_DATA_SHARED_MODULE_NAME "icudt.dll"
#endif
#endif

    namespace {
#if !defined(OS_NACL)
#if !defined(NDEBUG)
        // Assert that we are not called more than once.  Even though calling this
        // function isn't harmful (ICU can handle it), being called twice probably
        // indicates a programming error.
        bool g_check_called_once = true;
        bool g_called_once = false;
#endif // !defined(NDEBUG)

#if ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_FILE

        // To debug http://crbug.com/445616.
        int g_debug_icu_last_error;
        int g_debug_icu_load;
        int g_debug_icu_pf_error_details;
        int g_debug_icu_pf_last_error;
#if defined(OS_WIN)
        wchar_t g_debug_icu_pf_filename[_MAX_PATH];
#endif // OS_WIN                                                                    \
    // Use an unversioned file name to simplify a icu version update down the road. \
    // No need to change the filename in multiple places (gyp files, windows        \
    // build pkg configurations, etc). 'l' stands for Little Endian.                \
    // This variable is exported through the header file.
        const char kIcuDataFileName[] = "icudtl.dat";
#if defined(OS_ANDROID)
        const char kAndroidAssetsIcuDataFileName[] = "assets/icudtl.dat";
#endif

        // File handle intentionally never closed. Not using File here because its
        // Windows implementation guards against two instances owning the same
        // PlatformFile (which we allow since we know it is never freed).
        PlatformFile g_icudtl_pf = kInvalidPlatformFile;
        MemoryMappedFile* g_icudtl_mapped_file = nullptr;
        MemoryMappedFile::Region g_icudtl_region;

        void LazyInitIcuDataFile()
        {
            if (g_icudtl_pf != kInvalidPlatformFile) {
                return;
            }
#if defined(OS_ANDROID)
            int fd = base::android::OpenApkAsset(kAndroidAssetsIcuDataFileName,
                &g_icudtl_region);
            g_icudtl_pf = fd;
            if (fd != -1) {
                return;
            }
// For unit tests, data file is located on disk, so try there as a fallback.
#endif // defined(OS_ANDROID)
#if !defined(OS_MACOSX)
            FilePath data_path;
#if defined(OS_WIN)
            // The data file will be in the same directory as the current module.
            bool path_ok = PathService::Get(DIR_MODULE, &data_path);
            wchar_t tmp_buffer[_MAX_PATH] = { 0 };
            wcscpy_s(tmp_buffer, data_path.value().c_str());
            debug::Alias(tmp_buffer);
            CHECK(path_ok); // TODO(scottmg): http://crbug.com/445616
#elif defined(OS_ANDROID)
            bool path_ok = PathService::Get(DIR_ANDROID_APP_DATA, &data_path);
#else
            // For now, expect the data file to be alongside the executable.
            // This is sufficient while we work on unit tests, but will eventually
            // likely live in a data directory.
            bool path_ok = PathService::Get(DIR_EXE, &data_path);
#endif
            DCHECK(path_ok);
            data_path = data_path.AppendASCII(kIcuDataFileName);

#if defined(OS_WIN)
            // TODO(scottmg): http://crbug.com/445616
            wchar_t tmp_buffer2[_MAX_PATH] = { 0 };
            wcscpy_s(tmp_buffer2, data_path.value().c_str());
            debug::Alias(tmp_buffer2);
#endif

#else
            // Assume it is in the framework bundle's Resources directory.
            ScopedCFTypeRef<CFStringRef> data_file_name(
                SysUTF8ToCFStringRef(kIcuDataFileName));
            FilePath data_path = mac::PathForFrameworkBundleResource(data_file_name);
#if defined(OS_IOS)
            FilePath override_data_path = base::ios::FilePathOfEmbeddedICU();
            if (!override_data_path.empty()) {
                data_path = override_data_path;
            }
#endif // !defined(OS_IOS)
            if (data_path.empty()) {
                LOG(ERROR) << kIcuDataFileName << " not found in bundle";
                return;
            }
#endif // !defined(OS_MACOSX)
            File file(data_path, File::FLAG_OPEN | File::FLAG_READ);
            if (file.IsValid()) {
                // TODO(scottmg): http://crbug.com/445616.
                g_debug_icu_pf_last_error = 0;
                g_debug_icu_pf_error_details = 0;
#if defined(OS_WIN)
                g_debug_icu_pf_filename[0] = 0;
#endif // OS_WIN

                g_icudtl_pf = file.TakePlatformFile();
                g_icudtl_region = MemoryMappedFile::Region::kWholeFile;
            }
#if defined(OS_WIN)
            else {
                // TODO(scottmg): http://crbug.com/445616.
                g_debug_icu_pf_last_error = ::GetLastError();
                g_debug_icu_pf_error_details = file.error_details();
                wcscpy_s(g_debug_icu_pf_filename, data_path.value().c_str());
            }
#endif // OS_WIN
        }

        bool InitializeICUWithFileDescriptorInternal(
            PlatformFile data_fd,
            const MemoryMappedFile::Region& data_region)
        {
            // This can be called multiple times in tests.
            if (g_icudtl_mapped_file) {
                g_debug_icu_load = 0; // To debug http://crbug.com/445616.
                return true;
            }
            if (data_fd == kInvalidPlatformFile) {
                g_debug_icu_load = 1; // To debug http://crbug.com/445616.
                LOG(ERROR) << "Invalid file descriptor to ICU data received.";
                return false;
            }

            std::unique_ptr<MemoryMappedFile> icudtl_mapped_file(new MemoryMappedFile());
            if (!icudtl_mapped_file->Initialize(File(data_fd), data_region)) {
                g_debug_icu_load = 2; // To debug http://crbug.com/445616.
                LOG(ERROR) << "Couldn't mmap icu data file";
                return false;
            }
            g_icudtl_mapped_file = icudtl_mapped_file.release();

            UErrorCode err = U_ZERO_ERROR;
            udata_setCommonData(const_cast<uint8_t*>(g_icudtl_mapped_file->data()), &err);
            if (err != U_ZERO_ERROR) {
                g_debug_icu_load = 3; // To debug http://crbug.com/445616.
                g_debug_icu_last_error = err;
            }
            return err == U_ZERO_ERROR;
        }
#endif // ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_FILE
#endif // !defined(OS_NACL)

    } // namespace

#if !defined(OS_NACL)
#if ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_FILE
#if defined(OS_ANDROID)
    bool InitializeICUWithFileDescriptor(
        PlatformFile data_fd,
        const MemoryMappedFile::Region& data_region)
    {
#if !defined(NDEBUG)
        DCHECK(!g_check_called_once || !g_called_once);
        g_called_once = true;
#endif
        return InitializeICUWithFileDescriptorInternal(data_fd, data_region);
    }

    PlatformFile GetIcuDataFileHandle(MemoryMappedFile::Region* out_region)
    {
        CHECK_NE(g_icudtl_pf, kInvalidPlatformFile);
        *out_region = g_icudtl_region;
        return g_icudtl_pf;
    }
#endif

    const uint8_t* GetRawIcuMemory()
    {
        CHECK(g_icudtl_mapped_file);
        return g_icudtl_mapped_file->data();
    }

    bool InitializeICUFromRawMemory(const uint8_t* raw_memory)
    {
#if !defined(COMPONENT_BUILD)
#if !defined(NDEBUG)
        DCHECK(!g_check_called_once || !g_called_once);
        g_called_once = true;
#endif

        UErrorCode err = U_ZERO_ERROR;
        udata_setCommonData(const_cast<uint8_t*>(raw_memory), &err);
        return err == U_ZERO_ERROR;
#else
        return true;
#endif
    }

#endif // ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_FILE

    bool InitializeICU()
    {
#if !defined(NDEBUG)
        DCHECK(!g_check_called_once || !g_called_once);
        g_called_once = true;
#endif

        bool result;
#if (ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_SHARED)
        // We expect to find the ICU data module alongside the current module.
        FilePath data_path;
        PathService::Get(DIR_MODULE, &data_path);
        data_path = data_path.AppendASCII(ICU_UTIL_DATA_SHARED_MODULE_NAME);

        HMODULE module = LoadLibrary(data_path.value().c_str());
        if (!module) {
            LOG(ERROR) << "Failed to load " << ICU_UTIL_DATA_SHARED_MODULE_NAME;
            return false;
        }

        FARPROC addr = GetProcAddress(module, ICU_UTIL_DATA_SYMBOL);
        if (!addr) {
            LOG(ERROR) << ICU_UTIL_DATA_SYMBOL << ": not found in "
                       << ICU_UTIL_DATA_SHARED_MODULE_NAME;
            return false;
        }

        UErrorCode err = U_ZERO_ERROR;
        udata_setCommonData(reinterpret_cast<void*>(addr), &err);
        result = (err == U_ZERO_ERROR);
#elif (ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_STATIC)
        // The ICU data is statically linked.
        result = true;
#elif (ICU_UTIL_DATA_IMPL == ICU_UTIL_DATA_FILE)
        // If the ICU data directory is set, ICU won't actually load the data until
        // it is needed.  This can fail if the process is sandboxed at that time.
        // Instead, we map the file in and hand off the data so the sandbox won't
        // cause any problems.
        LazyInitIcuDataFile();
        result = InitializeICUWithFileDescriptorInternal(g_icudtl_pf, g_icudtl_region);
#if defined(OS_WIN)
        int debug_icu_load = g_debug_icu_load;
        debug::Alias(&debug_icu_load);
        int debug_icu_last_error = g_debug_icu_last_error;
        debug::Alias(&debug_icu_last_error);
        int debug_icu_pf_last_error = g_debug_icu_pf_last_error;
        debug::Alias(&debug_icu_pf_last_error);
        int debug_icu_pf_error_details = g_debug_icu_pf_error_details;
        debug::Alias(&debug_icu_pf_error_details);
        wchar_t debug_icu_pf_filename[_MAX_PATH] = { 0 };
        wcscpy_s(debug_icu_pf_filename, g_debug_icu_pf_filename);
        debug::Alias(&debug_icu_pf_filename);
        CHECK(result); // TODO(scottmg): http://crbug.com/445616
#endif
#endif

// To respond to the timezone change properly, the default timezone
// cache in ICU has to be populated on starting up.
// TODO(jungshik): Some callers do not care about tz at all. If necessary,
// add a boolean argument to this function to init'd the default tz only
// when requested.
#if defined(OS_LINUX) && !defined(OS_CHROMEOS)
        if (result)
            std::unique_ptr<icu::TimeZone> zone(icu::TimeZone::createDefault());
#endif
        return result;
    }
#endif // !defined(OS_NACL)

    void AllowMultipleInitializeCallsForTesting()
    {
#if !defined(NDEBUG) && !defined(OS_NACL)
        g_check_called_once = false;
#endif
    }

} // namespace i18n
} // namespace base
